home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / comm1 / exclutls.lha / Comments / CleanupComments.doc < prev    next >
Text File  |  1996-01-28  |  7KB  |  217 lines
  1. ;Released as public domain 28-Jan-1996 by the author Dave Dustin
  2.  
  3.  
  4.  
  5.  
  6.                           CleanupComments v1.1
  7.                           ~~~~~~~~~~~~~~~~~~~~
  8.                    (c) David Dustin / ECLIPSE Software
  9.  
  10.  
  11.                             13 February, 1994
  12.  
  13.  
  14.  
  15.    Preface
  16.    ~~~~~~~
  17.    The  programs  and  files  in this distribution are Shareware, but are
  18.    also  Copyright  (c)  David Dustin.  They may be freely distributed as
  19.    long  as  no  more  than  a  minimum  fee is charged to cover time and
  20.    copying  costs.   Permission is given for this distribution archive to
  21.    be placed into Public-Domain collections such as the Amiga Library run
  22.    by Fred Fish.
  23.  
  24.    They  may  also  be made freely available to any REGISTERED Excelsior!
  25.    BBS  sysops, and may be placed on any Support BBS's for the Excelsior!
  26.    BBS.
  27.  
  28.  
  29.    If  you do decide to make use of CleanupComments, you are suggested to
  30.    send any form of donation or gift as payment for continued usage.
  31.  
  32.  
  33.    If you do have any suggestions, bug notes or ideas about this program,
  34.    or if you would like to donate something, please let me know.
  35.  
  36.  
  37.        Write to me at the following address:
  38.  
  39.                                 David Dustin
  40.                               30 Richmond Ave
  41.                               Palmerston North
  42.                                 NEW ZEALAND
  43.  
  44.  
  45.        Or I can be contacted via:
  46.                           dave@eclipse.acme.gen.nz
  47.                          daved@eclipsnz.adsp.sub.org
  48.  
  49.                 BBS  -  +64-6-356-6375 (24hrs, V32bis, V42bis)
  50.  
  51.                    EMail to `Dave' on Skynet (Sycom's BBS)
  52.  
  53.  
  54.  
  55.    Contents
  56.    ~~~~~~~~
  57.        1.     An introduction
  58.        2.     Requirments
  59.        3.     Usage
  60.        4.     History
  61.        5.     Future
  62.        6.     Credits / Copyrights
  63.  
  64.  
  65.  
  66.  
  67.    1.  An Introduction
  68.    ~~~~~~~~~~~~~~~~~~~
  69.    With  Excelsior!, the descriptions of the files are stored in a single
  70.    file  called  _comments  in  each  area.   Along with this file is one
  71.    called _itemdata.
  72.  
  73.    Every  description  of a file is stored as ASCII in the _comments file
  74.    with a single 0x01 character between each entry.  Each time you update
  75.    a  description,  instead  of  just  modifing the original entry in the
  76.    _comments  file,  it  tags the replacement description onto the end of
  77.    the _comments file.
  78.  
  79.    This  ment  that  if you changed/updated the descriptions of files, or
  80.    killed  files,  there  would be a large amount of text that was always
  81.    just being skipped over.
  82.  
  83.    Due  to  Excelsior!  keeping  track  of  the  start  position  of  the
  84.    description  in  the _itemdata file, you are unable to either edit the
  85.    descriptions by hand, or deleted the unwanted descriptions.
  86.  
  87.    Until now.
  88.  
  89.  
  90.    CleanupComments  will by default remove any unwanted descriptions, and
  91.    sort the entries in the _comments file into the order that they appear
  92.    in the _itemdata file.
  93.  
  94.  
  95.    CleanupComments  will  now  also allow you to edit the descriptions by
  96.    hand, and to have more than the normal 5 line limit on descriptions
  97.  
  98.  
  99.  
  100. UPDATE:
  101.    <In  the latest betatest version of Excelsior, it would appear Tom has
  102.    added  a Cleanup function to Maint.  I have not tested this yet, but I
  103.    would  guess  it  does  the  same as mine (deletes old, and sorts into
  104.    order).   I  hate it when this happens.  But you can still use this to
  105.    allow longer than 5 line descriptions.>
  106.  
  107.  
  108.  
  109.  
  110.    2.  Requirments
  111.    ~~~~~~~~~~~~~~~
  112.    CleanupComments  can  be  used  on  any  Amiga with V36+, and does not
  113.    require Excelsior! to be running to work.
  114.  
  115.    In  fact,  it  would  be  preferable if no-one was in a file area when
  116.    CleanupComments  is run, as Excelsior!  buffers the list of files when
  117.    a user enters a area, and therefore the list will look incorrect.
  118.  
  119.    For  this  version,  you  must  launch  CleanupComments  from the same
  120.    directory  as your SystemData file.  From there, the program will sort
  121.    out the paths (I hope).
  122.  
  123.  
  124.  
  125.  
  126.    3.  Usage
  127.    ~~~~~~~~~
  128.    This version of CleanupComments can only be used from the SHELL.
  129.  
  130.    The arguments available are:  CLEANUP/S,CORRECT/S,MBASE/S
  131.  
  132.  
  133.      CLEANUP/S  - This will process all  file areas in sequence.  It will
  134.                   delete any unused descriptions from the _comments file,
  135.                   and  will  then sort then into the order that the files
  136.                   appear in the _itemdata file.
  137.  
  138.  
  139.      CORRECT/S  - Using this option means you can edit the _comments file
  140.                   by  hand.   You  _MUST_  have  used  the CLEANUP option
  141.                   before editing the _comments file.
  142.  
  143.                   It  will use the 0x010A characters in each entry as the
  144.                   marker  for  the end of the entry.  This means, as long
  145.                   as  you  only  edit the text itself, and leave the 0x01
  146.                   and the CR following it alone all will work fine.
  147.  
  148.  
  149.      MBASE/S    - This  tells  CleanupComments to use  the MBase.dat file
  150.                   instead of FBase.dat, which means that the Message base
  151.                   will  be processed instead of the files base.  This was
  152.                   added  because  files can also be uploaded to a message
  153.                   area with no effect on the system.
  154.  
  155.  
  156.    As  of  v1.1,  if you run CleanupComments directly in a files directory
  157.    area  (ie.  _itemdata and _comments are present in the same directory),
  158.    then  only that directory will be processed.  This allows you to change
  159.    the  comments in one area, and quickly correct the files without having
  160.    to process all the areas at the same time.
  161.  
  162.  
  163.  
  164.  
  165.    4.  History
  166.    ~~~~~~~~~~~
  167.    v0.1  6 February 94
  168.        *  First release.
  169.  
  170.  
  171.    v0.5  6 February 94
  172.        *  Made  use of SystemData and FBase.dat file for paths and areas.
  173.           This means you can process all areas in one go
  174.  
  175.    v1.0  7 February
  176.        *  Added CORRECT option
  177.        *  Added MBASE option
  178.        *  Fixed mistake in the version string (0.5 said 1.0)
  179.        *  Cleaned up text output.
  180.           - Now uses PutStr() for buffered output to StdOut()
  181.           - Added CR's to the end of each line (whoops)
  182.           - Highlighted Directories
  183.           - Actually tells you what it's doing
  184.        *  Changed from CD'd to new directories to just reading the file
  185.           using a full path.  Increased speed dramaticly
  186.  
  187.    v1.1  13 February
  188.        *  What can I say but:  v1.0 was completly stuffed.  It didn't
  189.           work in the slighest.  This version fixes all known bugs.
  190.        *  Now highlights UNet areas and won't try to process them
  191.        *  Added checking for local _itemdata and _comments file, thus
  192.           allowing processing of a single area
  193.  
  194.  
  195.  
  196.  
  197.    5.  Future
  198.    ~~~~~~~~~~
  199.    -  I  will  add FIDO area checking when I get a chance to find out what
  200.       bit is set in the ?Base.dat file.
  201.  
  202.    -  There  is  very  little  I  think  I could add.  If you can think of
  203.       something, TELL ME!
  204.  
  205.  
  206.  
  207.  
  208.  
  209.    6.  Credits / Copyrights
  210.    ~~~~~~~~~~~~~~~~~~~~~~~~
  211.        Main code                   - David Dustin
  212.        Bug testing                 - Renze de Ruiter
  213.  
  214.        CleanupComments             - (c) 1994 Eclipse Software
  215.        Excelsior! BBS              - (c) 1992-94 Sycom
  216.        Kickstart/Workbench         - (c) 1985-94 Commodore-Amiga, Inc.
  217.